home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 019a / dont10.zip / DONT10.DOC < prev    next >
Text File  |  1991-11-19  |  24KB  |  569 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.                                 D O N T   P A N I C
  12.  
  13.  
  14.                                     Version 1.0
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.                                 U s e r   G u i d e
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.                          (C) MicroGroove Consultants, 1991
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.                                        ╔╔╔╗
  42.                                        ╠╠╠╣
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.         
  58.         CONTENTS
  59.  
  60.             Introduction ....................................... 3
  61.  
  62.             Free For All ....................................... 3
  63.  
  64.             Using Dont Panic ................................... 4
  65.  
  66.             Functions .......................................... 5
  67.  
  68.                 Line Functions ................................. 5
  69.  
  70.                     EDIT
  71.                     INSERT
  72.                     DELETE
  73.                     MOVE
  74.                     COPY
  75.                     BLANK
  76.  
  77.                 List Functions ................................. 6
  78.  
  79.                     NEW
  80.                     OPEN
  81.                     SAVE
  82.                     PRINT
  83.  
  84.                 System Functions ............................... 8
  85.  
  86.                     SETUP
  87.                     QUIT
  88.  
  89.             File Format ........................................ 9
  90.  
  91.             Some Comments from the Author ...................... 10
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.                                       Page 2
  114.         
  115.         INTRODUCTION
  116.  
  117.         Dont Panic is simply a list; nothing more than that. Unlike a paper
  118.         list,  however, each  line Panic  can be  edited, copied  and moved
  119.         around  to  change  or  update  the  list  as  required as often as
  120.         necessary.  This  makes  it  ideal  for  maintaining lists that are
  121.         constantly changing. Each  time, the list can be  saved on disk for
  122.         recall at a  later date. A simple printout  facility allows a paper
  123.         copy to be obtained.
  124.  
  125.         Dont Panic was originally conceived as  a Things To Do list manager
  126.         but has  since found use  as a very  simple outliner (for  planning
  127.         memos,  short reports  etc), a  simple index,  a weekly planner and
  128.         even a football league table chart!
  129.  
  130.         This user guide  explains how to compile and  edit lists using Dont
  131.         Panic.
  132.  
  133.  
  134.  
  135.         FREE FOR ALL
  136.  
  137.         Dont Panic is  not Shareware nor is it in  the Public Domain but is
  138.         distributed as  Freeware according to  the 'Free For  All' concept.
  139.         This means  that although the copyright  is retained by MicroGroove
  140.         Consultants,  the software  is freely  available for  use by anyone
  141.         without  any  payment.  For  further  details  of  the Free For All
  142.         concept   and  distribution   requirements  see   the  accompanying
  143.         documentation contained in the file FFA_91.DOC.
  144.  
  145.         This software may be freely given  to anyone providing no charge is
  146.         made for the software itself; a  minimal charge may be made for the
  147.         distribution  media,   though  free  distribution   is  encouraged.
  148.         Furthermore,  this software  may only  be distributed  as a  single
  149.         archived file (in which form you should have received it).
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.                                       Page 3
  171.         
  172.         USING DONT PANIC
  173.  
  174.         Once  the  introductory  screen  has  cleared  the main screen will
  175.         appear.  This  consists  of  three  parts;  the  text  window,  the
  176.         title/status line at the top of the  screen and the menu bar at the
  177.         bottom.
  178.  
  179.         The  text window  shows the  list currently  in memory and occupies
  180.         most of the screen. Each list consists  of 99 lines of text each 70
  181.         characters long. (Each list is this  size regardless of how much of
  182.         it  actually contains  text.) On  the left  of the  screen are line
  183.         numbers, each refering to a line in the current list.
  184.  
  185.         Many  of  the  editing   functions  available  are  performed  with
  186.         reference  to a  particular line.  This line,  the current line, is
  187.         indicated by an on screen pointer and also indicated numerically on
  188.         the status  line. The line pointer  is moved using the  up and down
  189.         cursor  keys and  will scroll  the entire  screen when  the top  or
  190.         bottom line  is reached. The  [Page Up] and  [Page Down] keys  will
  191.         move  the text  displayed up  and  down  17 lines  at a  time while
  192.         retaining the position of the pointer relative to the screen.
  193.  
  194.         In addition to the current line,  the status line shows the name of
  195.         the file  currently in use  and an Ins/Ovr  flag indicating whether
  196.         text is inserted or overwritten during editing.
  197.  
  198.         The menu  bar forms the bottom  line of the display  and provides a
  199.         reminder of  the functions available. Each  function is accessed by
  200.         pressing  the key  corresponding to  the highlighted  letter on the
  201.         menu bar.
  202.  
  203.         On starting Dont Panic each line  will of course be blank, the line
  204.         pointer will  be at line  one and the  filename indicator will  say
  205.         'using new file'.
  206.  
  207.         At various times Dont Panic  will require information to be entered
  208.         by the  user; this is  done using 'dialogue  boxes'. There are  two
  209.         types  of such  box in  Dont Panic;  information dialogue boxes and
  210.         warning dialogue boxes.
  211.  
  212.         An information  dialogue box will  appear when Dont  Panic requires
  213.         information, such as a filename or  a line number or, most notably,
  214.         text for a line of the list.
  215.  
  216.         A warning dialogue box will appear  when Dont Panic wishes to alert
  217.         the user  to some fact  regarding its operation.  For example, this
  218.         could be  that data is  about to be  lost or that  a specified file
  219.         cannot  be  found.  The  dialogue  box  will  ask for permission to
  220.         proceed at which point the function can be cancelled if necessary.
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.                                       Page 4
  228.         
  229.         DONT PANIC FUNCTIONS
  230.  
  231.         This section  lists all the  functions available and  explains what
  232.         they do and how they do it.
  233.  
  234.         Dont Panic functions can be divided into three groups - those which
  235.         affect a single line at a time, those which affect the entire list,
  236.         and those which affect the system itself.
  237.  
  238.  
  239.         1  LINE FUNCTIONS
  240.  
  241.  
  242.         1.1 EDIT    Edit will invoke the line edit  box at the  foot of the
  243.                     screen with  the contents of  the current line  present
  244.                     for  editing.  The  line  text  may  then  be edited as
  245.                     required. The cursor is moved  back and forth along the
  246.                     line  in the  usual way  using the  left/right keys and
  247.                     home/end. Backspace and delete  have their normal erase
  248.                     functions while insert will toggle the overwrite status
  249.                     of the edit cursor. This is automatically set to insert
  250.                     when  the  edit  box  is  invoked,  regardless  of  its
  251.                     original state,  but may be toggled  as required during
  252.                     editing.
  253.  
  254.                     Once  the text  has been  edited, pressing  return will
  255.                     update   the   current   line   with   the   new  text.
  256.                     Alternatively, pressing escape will abandon editing and
  257.                     reinstate the original text.
  258.  
  259.         1.2 INSERT  Insert will introduce a blank line  at the current line
  260.                     position  and   move  all  subsequent   lines  down  to
  261.                     accommodate it. If text is present on the final line of
  262.                     the list  (line 99) a warning  dialogue box will appear
  263.                     with  a request  to abandon  the line.  Pressing [N] or
  264.                     escape  will cancel  the insert  function and  the list
  265.                     will  be left  unaffected. Pressing  [Y] will  insert a
  266.                     blank line with the loss of text at line 99.
  267.  
  268.         1.3 DELETE  Delete will remove the current line  and all subsequent
  269.                     lines  will be  moved up  to fill  the gap.  If text is
  270.                     present at the current line when the function is called
  271.                     a warning  dialogue box will  appear with a  request to
  272.                     delete the text. Pressing [N] or escape will cancel the
  273.                     function  with  no  deletion,  while  pressing [Y] will
  274.                     delete the line. A blank line  will be added to the end
  275.                     of the list to preserve its length.
  276.  
  277.         1.4 MOVE    Move will transfer the current line to a specified line
  278.                     number, all lines between the new and old positions are
  279.                     shuffled up  or down to  take account of  the lines new
  280.                     position. On  pressing [M] an  information dialogue box
  281.                     will appear  requesting the new  line number. Once  the
  282.                     current  line  has  been  moved  the  line pointer will
  283.  
  284.                                       Page 5
  285.         
  286.                     retain  its  original  position,  indicating  the  line
  287.                     filling the gap vacated by the moved line.
  288.  
  289.         1.5  COPY   Copy will copy  the  text at  a  specified  line to the
  290.                     current line.  On pressing [C]  an information dialogue
  291.                     box will appear requesting the number of the line to be
  292.                     copied.  A copy  of this  line will  be inserted at the
  293.                     current  position. If  text is  already present  at the
  294.                     current line a warning dialogue  box will appear with a
  295.                     request to  overwrite the text. Pressing  [N] or escape
  296.                     will  cancel  the  function  leaving  the  current line
  297.                     untouched. Pressing  [Y] will proceed  with copying and
  298.                     the  current line  will  be  overwritten with  the line
  299.                     specified.
  300.  
  301.  
  302.         1.6 BLANK   Blank will replace the current line with a  blank line.
  303.                     If there is text already present a warning dialogue box
  304.                     will appear with a request  to blank the text. Pressing
  305.                     [N] or escape will cancel the function leaving the text
  306.                     unaffected while [Y] will cause  it to be cleared. This
  307.                     is  useful when  an entry  is to  be deleted  but where
  308.                     preserving  the  numbers  of  the  remaining  lines  is
  309.                     important.
  310.  
  311.  
  312.  
  313.         2  LIST FUNCTIONS
  314.  
  315.         2.1 NEW     New will clear the current  list  from memory, clearing
  316.                     the display and resetting  the line pointer to position
  317.                     1. If the list has not  been saved it will be lost. The
  318.                     current file indicator is reset to 'new file'.
  319.  
  320.         2.2 OPEN    Open will load a new list into memory, overwriting  any
  321.                     list  already present.  On pressing  [O] an information
  322.                     dialogue box will appear with a request for the name of
  323.                     the file to be opened. All Dont Panic files have a .PAN
  324.                     extension, hence  only eight characters  are requested.
  325.  
  326.                     Once  the filename  has been  entered, pressing  return
  327.                     will  instruct the  system to  search the  default file
  328.                     path (see  Setup) for the  file. If found  this will be
  329.                     loaded. If the file is not found a warning dialogue box
  330.                     to this  effect appear and an  information dialogue box
  331.                     will reappear to request another filename. The filename
  332.                     can  be retyped  or  the  function abandoned  using the
  333.                     escape  key.  At  anytime  during  the  typing  of  the
  334.                     filename, pressing  escape will cancel  the function as
  335.                     will entering  a blank filename. Any  list currently in
  336.                     use will be unaffected until a new file is opened.
  337.  
  338.  
  339.  
  340.  
  341.                                       Page 6
  342.         
  343.                     When first  starting Dont Panic or  after using the NEW
  344.                     function,  the filename  dialogue box  will appear with
  345.                     the default filename already  present (see Setup). This
  346.                     is  to  allow  an  often   loaded  file  to  be  loaded
  347.                     immediately by simply pressing  return. If this file is
  348.                     not required,  another filename may  be typed over  the
  349.                     default  name.   The  overwrite  status   will  be  set
  350.                     automatically to  Ovr to facilitate  this.
  351.  
  352.                     Once a file has been  loaded, the filename dialogue box
  353.                     will appear with this  filename rather than the default
  354.                     (see Save). The current filename indicator will also be
  355.                     set to display the name of the file loaded.
  356.  
  357.  
  358.         2.3 SAVE    Save  will store a copy of  the current list in a  file
  359.                     at  the  location  named  in  the  file  path. Any file
  360.                     already  present with  this name  will be automatically
  361.                     overwritten.
  362.  
  363.                     On pressing [S] an information dialogue box will appear
  364.                     with a  request for the name  of the file to  which the
  365.                     list is  to be copied.  The file will  automatically be
  366.                     given  a .PAN  extension so  only eight  characters are
  367.                     requested.
  368.  
  369.                     Once  the filename  has been  entered, pressing  return
  370.                     will instruct the system to check the default file path
  371.                     (see Setup) to ensure it  is writable and the list will
  372.                     be  saved.  If  the  list  cannot  be  saved  a warning
  373.                     dialogue box to this effect appears and the information
  374.                     dialogue box will reappear to request another filename.
  375.                     The filename  can be retyped or  the function abandoned
  376.                     using the  escape key.
  377.  
  378.                     At anytime during the  typing of the filename, pressing
  379.                     escape  will cancel  the  function  as will  entering a
  380.                     blank  filename.  The  list  currently  in  use will be
  381.                     retained until cleared by NEW or a new file is opened.
  382.  
  383.  
  384.         2.4 PRINT   This will send the current list to an attached printer.
  385.                     On pressing  [P] a warning dialogue  box will appear to
  386.                     request  confirmation. Pressing  [N] or  escape at this
  387.                     point will  cancel the function while  [Y] will proceed
  388.                     with printing.
  389.  
  390.                     WARNING:  If  there  is  no  printer  attached  to your
  391.                     computer, do  not instruct Dont Panic  to print. If you
  392.                     do   the  system   will  wait   indefinitely  for   the
  393.                     non-existent  printer  to  respond  to  its request for
  394.                     printing and  a reboot will be  necessary. If the print
  395.                     function  is  called  accidentally,  it  may  be safely
  396.                     exited by pressing [N] or escape.
  397.  
  398.                                       Page 7
  399.         
  400.                     Dont Panic will print only as far as the last used line
  401.                     of the current list; for example, if the list only goes
  402.                     as  far  as  line  34,  so  too  will the printout. The
  403.                     printout may  be produced single or  double spaced with
  404.                     or without  the time, date  and filename at  the top of
  405.                     the first page. These  options are determined using the
  406.                     Setup option.
  407.  
  408.  
  409.  
  410.         3  SYSTEM FUNCTIONS
  411.  
  412.         3.1 SETUP   This allows the system  colours  and default parameters
  413.                     to  be  changed  and  if  required,  stored on disk for
  414.                     future use.
  415.  
  416.                     On startup Dont Panic will search the current directory
  417.                     for a  configuration file PANIC.CFG from  which it will
  418.                     load  the system  parameters.  If  this file  cannot be
  419.                     found Dont Panic will use its own default parameters.
  420.  
  421.                     On pressing [T]  the text screen will be  replaced by a
  422.                     colour chart and  a request for the value  of the first
  423.                     parameter. The  current value will be  shown and may be
  424.                     overwritten  with  a  new  value.  Pressing return will
  425.                     enter  this value  and providing  it is  within a range
  426.                     acceptable to the system the parameter will be updated.
  427.                     If it  is beyond the acceptable  range, the system will
  428.                     retain  the original  value of  the parameter. Pressing
  429.                     escape will  also tell the  system to use  the original
  430.                     value  of the  parameter, regardless  of what  has been
  431.                     entered.
  432.  
  433.                     Each parameter will be prompted in turn and a new value
  434.                     should be entered. The parameters are as follows;
  435.  
  436.                     System Colours;
  437.  
  438.                         Main text colour
  439.                         Main text screen background
  440.                         Title bar text and unhighlighted menu text colour
  441.                         Highlighted menu text colour
  442.                         Title bar and menu background colour
  443.                         Cursor foreground colour
  444.                         Cursor background colour
  445.                         Warning dialogue text colour
  446.                         Warning dialogue box colour
  447.                         Information dialogue text colour
  448.                         Information dialogue box colour
  449.                         Border colour
  450.                         Border background colour
  451.  
  452.  
  453.  
  454.                                       Page 8
  455.  
  456.         
  457.                     The system colours are entered as numbers the values of
  458.                     which can be determined from the colour chart displayed
  459.                     on screen.
  460.  
  461.  
  462.                     System Defaults;
  463.  
  464.                         Data file storage path (eg. A:\DONT\FILES\)
  465.                         Default filename (eg. TO_DO)
  466.  
  467.                     Printer Defaults;
  468.  
  469.                         Lines double spaced    (Y or N)
  470.                         Time/date heading    (Y or N)
  471.  
  472.                     Once the new values have  been entered a prompt to save
  473.                     these to  disk will appear. Pressing  [Y] will save the
  474.                     parameters  to  the  file  PANIC.CFG  (creating  it  if
  475.                     necessary) and then return to the text screen. Pressing
  476.                     [N] will  not save the parameters  to the configuration
  477.                     file but they  will be used while the  program is still
  478.                     running  (or  until  they  are  altered  by  setup). On
  479.                     restarting the program the default values will again be
  480.                     used.
  481.  
  482.  
  483.         3.2  QUIT   This will exit  Dont Panic and return  to the operating
  484.                     system. Any  list in memory  will be lost.  On pressing
  485.                     [Q] a  warning dialogue box will  appear with a request
  486.                     to proceed. Pressing [Y] will  quit while [N] or escape
  487.                     will cancel.
  488.  
  489.  
  490.  
  491.         FILE FORMAT
  492.  
  493.         For Simplicity Dont Panic stores its data in ASCII format with each
  494.         line delimited by ".  Thus if " is used in a  list, the system will
  495.         convert it  to '. This is  necessary to prevent the  line structure
  496.         from being corrupted  by extra " which normally  mark the beginning
  497.         and end of each line.
  498.  
  499.         Because the files  are in ASCII format they  can easily be imported
  500.         into most  word processors. Once  loaded the processors  search and
  501.         replace  facility can  be used  to replace  all the  " markers with
  502.         spaces.
  503.  
  504.  
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512.                                       Page 9
  513.         
  514.         SOME COMMENTS FROM THE AUTHOR
  515.  
  516.         It  must  be  said  that  Dont  Panic  does  nothing that cannot be
  517.         achieved  using  a  word  processor  or  a  conventional  outlining
  518.         package.  If  you  require   nicely  formatted  lists,  printed  to
  519.         perfection then a word processor would undoubtedly suit you better.
  520.         If  you require  complicated outlines  with flexible  numbering and
  521.         indentation/promotion of  items then an outliner  would be far more
  522.         useful than Dont Panic. Dont Panic  has been used as a simple index
  523.         but  for anything  more complex  a database  would probably be more
  524.         suitable.  The data  format allows  lists to  be incorporated  into
  525.         documents without too  much trouble if necessary but  if this is to
  526.         be done why not create the list as a document in the first place?
  527.  
  528.         So why use Dont Panic at all?
  529.  
  530.         Dont Panic  scores over the more  dedicated applications that could
  531.         be used in its place in two important respects. Firstly, it is very
  532.         simple; lists  can be created,  edited, stored, retrieved,  edited,
  533.         printed  and   so  on.  Secondly,   it  is  FREE!   The  degree  of
  534.         customisation available allows colour schemes  to be decided by the
  535.         user  while the  default filename  allows the  quick retrieval  and
  536.         storage of a list which is used time and again.
  537.  
  538.         Admittedly,  the  editing  facilities   available  are  quite  slow
  539.         (unusably so on  an XT machine) but with a  286 processor or better
  540.         Dont Panic is  simple and straight forward to  use. Enough features
  541.         have been added to allow quick loading, editing and saving of lists
  542.         but the temptation to overfeature the program has been resisted.
  543.  
  544.         This, version 1.0, of Dont Panic  has been released as Freeware for
  545.         all to  use if they  so wish. If  you find it  useful, but find its
  546.         idiosyncrasies a little hard to live with then look out for version
  547.         2.0 which should  be appearing in the not  too distant future. This
  548.         will  be appearing  as Shareware,  rather than  Freeware, but  will
  549.         conform  to  the  IBM  CUA  interface  conventions and include many
  550.         improvements over version 1.0 most notably in the area of speed.
  551.  
  552.  
  553.  
  554.                                                 Steve Walker
  555.                                                 MicroGroove Consultants
  556.                                                 November 1991
  557.  
  558.  
  559.                       --------------------------------------
  560.                                        ╔╔╔╗
  561.                                        ╠╠╠╣
  562.  
  563.  
  564.  
  565.  
  566.  
  567.                                       Page 10
  568.  
  569.